<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.storage</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;storage
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="simvoc.core.storage-module.html">Module simvoc.core.storage</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"># Simulated storage-related components</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"># Author:   Mike Murphy &lt;mamurph@cs.clemson.edu&gt;</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"># Revision: 23 September 2009</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment">#   Copyright 2009 Clemson University</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment">#   Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment">#   you may not use this file except in compliance with the License.</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment">#   You may obtain a copy of the License at</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment">#       http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-comment">#   Unless required by applicable law or agreed to in writing, software</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-comment">#   distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-comment">#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-comment">#   See the License for the specific language governing permissions and</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-comment">#   limitations under the License.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-comment"># This material is based upon work supported under a National Science</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-comment"># Foundation Graduate Research Fellowship. Any opinions, findings,</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-comment"># conclusions or recommendations expressed in this publication are those of</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-comment"># the author(s) and do not necessarily reflect the views of the National</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-comment"># Science Foundation.</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module simvoc.core.results=simvoc.core.results-module.html"><a title="simvoc.core.results" class="py-name" href="#" onclick="return doclink('link-0', 'results', 'link-0');">results</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Class simvoc.core.results.FileRequestResult=simvoc.core.results.FileRequestResult-class.html"><a title="simvoc.core.results.FileRequestResult" class="py-name" href="#" onclick="return doclink('link-1', 'FileRequestResult', 'link-1');">FileRequestResult</a></tt><tt class="py-op">,</tt> <tt id="link-2" class="py-name" targets="Class simvoc.core.results.FileTransferResult=simvoc.core.results.FileTransferResult-class.html"><a title="simvoc.core.results.FileTransferResult" class="py-name" href="#" onclick="return doclink('link-2', 'FileTransferResult', 'link-2');">FileTransferResult</a></tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"> </tt>
<a name="DataFile"></a><div id="DataFile-def"><a name="L31"></a><tt class="py-lineno"> 31</tt> <a class="py-toggle" href="#" id="DataFile-toggle" onclick="return toggle('DataFile');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.storage.DataFile-class.html">DataFile</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DataFile-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DataFile-expanded"><a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">   Simulation of a data file or other large piece of data that must be</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">   transferred over a Wide Area Network</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="DataFile.__init__"></a><div id="DataFile.__init__-def"><a name="L36"></a><tt class="py-lineno"> 36</tt> <a class="py-toggle" href="#" id="DataFile.__init__-toggle" onclick="return toggle('DataFile.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.DataFile-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">size</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DataFile.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="DataFile.__init__-expanded"><a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">      @param name: Name of the simulated file</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">      @type name: str</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">      @param size: Size of the simulated file in BYTES</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">      @type size: int</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: File extra data</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">name</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">size</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">extra_data</tt> <tt class="py-op">=</tt> <tt class="py-name">kwds</tt> </tt>
</div><a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="DataFile.transfer"></a><div id="DataFile.transfer-def"><a name="L48"></a><tt class="py-lineno"> 48</tt> <a class="py-toggle" href="#" id="DataFile.transfer-toggle" onclick="return toggle('DataFile.transfer');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.DataFile-class.html#transfer">transfer</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">start_time</tt><tt class="py-op">,</tt> <tt class="py-param">speed</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">,</tt> <tt class="py-param">server_name</tt><tt class="py-op">,</tt> \ </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line">                <tt class="py-param">client_name</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DataFile.transfer-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="DataFile.transfer-expanded"><a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">      Schedules a transfer of the DataFile from a server to a client. Transfer</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">      times are computed using the transfer speed. A transfer speed of zero is</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">      used to indicate that the transfer is instantaneous (for allowing</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">      experiments to enable/disable transfer time simulation)</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the simulator instance</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">      @param start_time: Transfer start time</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">      @type start_time: number</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">      @param speed: Transfer speed in BYTES per second (see the L{units}</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">                    module for convenient constants)</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">      @type speed: number</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">      @param callback: Callback function to execute when the transfer</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">                       completes. This function must be simulator-aware</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">                       and will receive arguments: current time, simulator</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">                       reference, filename, a reference to this object,</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">                       the name of the server, the name of the client, and</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">                       the transfer speed</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">      @param server_name: Name of the server from which the file is to be</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">                          transferred</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">      @type server_name: str</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">      @param client_name: Name of the client to which the file is to be</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">                          transferred</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">      @type client_name: str</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">speed</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">         <tt class="py-name">xfer_time</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> <tt class="py-op">/</tt> <tt class="py-name">speed</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line">         <tt class="py-name">end_time</tt> <tt class="py-op">=</tt> <tt class="py-name">start_time</tt> <tt class="py-op">+</tt> <tt class="py-name">xfer_time</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">      <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">         <tt class="py-comment"># Transfer is instant if speed is non-positive. This "feature"</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line">         <tt class="py-comment"># allows the file server/client pair to be used on a local site,</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line">         <tt class="py-comment"># permitting one pilot job implementation to cover several cases.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">         <tt class="py-name">end_time</tt> <tt class="py-op">=</tt> <tt class="py-name">start_time</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">callback</tt><tt class="py-op">:</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">         <tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method simvoc.core.kernel.EventQueue.new_simple_event()=simvoc.core.kernel.EventQueue-class.html#new_simple_event,Method simvoc.core.kernel.Simulator.new_simple_event()=simvoc.core.kernel.Simulator-class.html#new_simple_event"><a title="simvoc.core.kernel.EventQueue.new_simple_event
simvoc.core.kernel.Simulator.new_simple_event" class="py-name" href="#" onclick="return doclink('link-3', 'new_simple_event', 'link-3');">new_simple_event</a></tt><tt class="py-op">(</tt><tt class="py-name">end_time</tt><tt class="py-op">,</tt> <tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">,</tt> \ </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line">                              <tt class="py-name">server_name</tt><tt class="py-op">,</tt> <tt class="py-name">client_name</tt><tt class="py-op">,</tt> <tt class="py-name">speed</tt><tt class="py-op">)</tt> </tt>
</div><a name="DataFile.__str__"></a><div id="DataFile.__str__-def"><a name="L86"></a><tt class="py-lineno"> 86</tt> <a class="py-toggle" href="#" id="DataFile.__str__-toggle" onclick="return toggle('DataFile.__str__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.DataFile-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DataFile.__str__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="DataFile.__str__-expanded"><a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-string">'%s (%d)'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">size</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"> </tt>
<a name="FileCache"></a><div id="FileCache-def"><a name="L91"></a><tt class="py-lineno"> 91</tt> <a class="py-toggle" href="#" id="FileCache-toggle" onclick="return toggle('FileCache');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html">FileCache</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="FileCache-expanded"><a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-docstring">   Transparent file cache: transfers a file if necessary; otherwise, raises</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">   a callback event at the current simulator clock time to notify client code</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">   that the simulated file is ready for simulated use. Note that this cache</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">   does not provide any internal expiration mechanism. Once a file has been</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">   received into the cache, it remains in the cache permanently.</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="FileCache.__init__"></a><div id="FileCache.__init__-def"><a name="L99"></a><tt class="py-lineno"> 99</tt> <a class="py-toggle" href="#" id="FileCache.__init__-toggle" onclick="return toggle('FileCache.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">speed</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.__init__-expanded"><a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">      @param name: Name of the file cache</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">      @type name: str</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the simulator instance</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">      @param speed: Speed of the network link into the file cache, in</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">                    BYTES per second (see L{units} for constants). A speed of</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">                    zero will result in instantaneous transfers.</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">      @type speed: number</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Extra data</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">name</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt> <tt class="py-op">=</tt> <tt class="py-name">sim</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">speed</tt> <tt class="py-op">=</tt> <tt class="py-name">speed</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">extra_data</tt> <tt class="py-op">=</tt> <tt class="py-name">kwds</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stores</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="FileCache.xfer_complete"></a><div id="FileCache.xfer_complete-def"><a name="L117"></a><tt class="py-lineno">117</tt> <a class="py-toggle" href="#" id="FileCache.xfer_complete-toggle" onclick="return toggle('FileCache.xfer_complete');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#xfer_complete">xfer_complete</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">cur_time</tt><tt class="py-op">,</tt> <tt class="py-param">simobj</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">datafile</tt><tt class="py-op">,</tt> <tt class="py-param">srv_n</tt><tt class="py-op">,</tt> \ </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line">                    <tt class="py-param">cli_n</tt><tt class="py-op">,</tt> <tt class="py-param">speed</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.xfer_complete-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.xfer_complete-expanded"><a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">      Method invoked by a simulator event when a file becomes available in</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">      the file cache. Notifies client code of file availability by means of</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">      a callback function.</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">      @param cur_time: Current simulated time</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">      @type cur_time: number</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">      @param simobj: Reference to the simulator object</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the file</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">      @param datafile: Reference to the DataFile object</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">      @param srv_n: Name of the file server</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">      @type srv_n: str</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">      @param cli_n: Name of the file cache</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring">      @type cli_n: str</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-docstring">      @param speed: Transfer speed in BYTES per second (see L{units})</tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-docstring">      @type speed: number</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: L{results.FileTransferResult}</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line">      <tt class="py-keyword">for</tt> <tt class="py-name">callback</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt><tt class="py-op">:</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_simple_event
simvoc.core.kernel.Simulator.new_simple_event" class="py-name" href="#" onclick="return doclink('link-4', 'new_simple_event', 'link-3');">new_simple_event</a></tt><tt class="py-op">(</tt><tt class="py-name">cur_time</tt><tt class="py-op">,</tt> <tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">datafile</tt><tt class="py-op">)</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line">      <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line">      <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt><tt class="py-op">.</tt><tt class="py-name">size</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line">      <tt class="py-name">ts</tt> <tt class="py-op">=</tt> <tt class="py-name">simobj</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method simvoc.core.kernel.Simulator.get_timestamp()=simvoc.core.kernel.Simulator-class.html#get_timestamp"><a title="simvoc.core.kernel.Simulator.get_timestamp" class="py-name" href="#" onclick="return doclink('link-5', 'get_timestamp', 'link-5');">get_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt id="link-6" class="py-name"><a title="simvoc.core.results.FileTransferResult" class="py-name" href="#" onclick="return doclink('link-6', 'FileTransferResult', 'link-2');">FileTransferResult</a></tt><tt class="py-op">(</tt><tt class="py-name">ts</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">,</tt> <tt class="py-name">srv_n</tt><tt class="py-op">,</tt> <tt class="py-name">cli_n</tt><tt class="py-op">,</tt> <tt class="py-name">speed</tt><tt class="py-op">)</tt> </tt>
</div><a name="FileCache.get_file"></a><div id="FileCache.get_file-def"><a name="L146"></a><tt class="py-lineno">146</tt> <a class="py-toggle" href="#" id="FileCache.get_file-toggle" onclick="return toggle('FileCache.get_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#get_file">get_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.get_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.get_file-expanded"><a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring">      Requests a file from the cache. If the file is not in the cache, all</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">      known servers are queried to locate the file, and the file is</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring">      transferred into the cache. If the file cannot be found on any server,</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">      an Exception occurs.</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">      This method works asynchronously: client code must specify a callback</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"><tt class="py-docstring">      function, which will take two arguments: the filename and the DataFile</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line"><tt class="py-docstring">      instance itself. This callback will be invoked once the file becomes</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"><tt class="py-docstring">      available in the cache.</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the DataFile to request</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-docstring">      @param callback: Callback function to invoke when the file becomes</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line"><tt class="py-docstring">                       available</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: L{results.FileRequestResult}</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">      <tt class="py-name">now</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method simvoc.core.kernel.Simulator.get_time()=simvoc.core.kernel.Simulator-class.html#get_time"><a title="simvoc.core.kernel.Simulator.get_time" class="py-name" href="#" onclick="return doclink('link-7', 'get_time', 'link-7');">get_time</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">      <tt class="py-name">nowstamp</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="simvoc.core.kernel.Simulator.get_timestamp" class="py-name" href="#" onclick="return doclink('link-8', 'get_timestamp', 'link-5');">get_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">      <tt class="py-name">cached</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">:</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line">         <tt class="py-name">datafile</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_simple_event
simvoc.core.kernel.Simulator.new_simple_event" class="py-name" href="#" onclick="return doclink('link-9', 'new_simple_event', 'link-3');">new_simple_event</a></tt><tt class="py-op">(</tt><tt class="py-name">now</tt><tt class="py-op">,</tt> <tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">datafile</tt><tt class="py-op">)</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">         <tt class="py-name">cached</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line">      <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt><tt class="py-op">:</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method simvoc.core.duplicate_filter.DuplicateFilter.append()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#append,Method simvoc.core.filter_results.ResultFilter.append()=simvoc.core.filter_results.ResultFilter-class.html#append,Method simvoc.core.kernel.Output.append()=simvoc.core.kernel.Output-class.html#append"><a title="simvoc.core.duplicate_filter.DuplicateFilter.append
simvoc.core.filter_results.ResultFilter.append
simvoc.core.kernel.Output.append" class="py-name" href="#" onclick="return doclink('link-10', 'append', 'link-10');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">callback</tt><tt class="py-op">)</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line">         <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line">            <tt class="py-name">found</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">store</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stores</tt><tt class="py-op">:</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line">               <tt class="py-keyword">if</tt> <tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method simvoc.core.storage.FileStore.has_file()=simvoc.core.storage.FileStore-class.html#has_file"><a title="simvoc.core.storage.FileStore.has_file" class="py-name" href="#" onclick="return doclink('link-11', 'has_file', 'link-11');">has_file</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line">                  <tt class="py-name">store</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name" targets="Method simvoc.core.storage.FileCache.get_file()=simvoc.core.storage.FileCache-class.html#get_file,Method simvoc.core.storage.FileStore.get_file()=simvoc.core.storage.FileStore-class.html#get_file"><a title="simvoc.core.storage.FileCache.get_file
simvoc.core.storage.FileStore.get_file" class="py-name" href="#" onclick="return doclink('link-12', 'get_file', 'link-12');">get_file</a></tt><tt class="py-op">(</tt><tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">speed</tt><tt class="py-op">,</tt> \ </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line">                                 <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method simvoc.core.storage.FileCache.xfer_complete()=simvoc.core.storage.FileCache-class.html#xfer_complete"><a title="simvoc.core.storage.FileCache.xfer_complete" class="py-name" href="#" onclick="return doclink('link-13', 'xfer_complete', 'link-13');">xfer_complete</a></tt><tt class="py-op">)</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line">                  <tt class="py-name">found</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line">                  <tt class="py-keyword">break</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line">            <tt class="py-comment">#</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">found</tt><tt class="py-op">:</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">pending</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt> <tt class="py-name">callback</tt> <tt class="py-op">]</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line">               <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Simulated file not found in any store'</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt id="link-14" class="py-name"><a title="simvoc.core.results.FileRequestResult" class="py-name" href="#" onclick="return doclink('link-14', 'FileRequestResult', 'link-1');">FileRequestResult</a></tt><tt class="py-op">(</tt><tt class="py-name">nowstamp</tt><tt class="py-op">,</tt> <tt class="py-name">filename</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">cached</tt><tt class="py-op">)</tt> </tt>
</div><a name="FileCache.add_file"></a><div id="FileCache.add_file-def"><a name="L189"></a><tt class="py-lineno">189</tt> <a class="py-toggle" href="#" id="FileCache.add_file-toggle" onclick="return toggle('FileCache.add_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#add_file">add_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">datafile</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.add_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.add_file-expanded"><a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-docstring">      Adds a file directly into the cache, without transferring it across</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">      the network</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">      @param datafile: DataFile instance to add to the cache</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line">      <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt> </tt>
</div><a name="FileCache.flush_file"></a><div id="FileCache.flush_file-def"><a name="L198"></a><tt class="py-lineno">198</tt> <a class="py-toggle" href="#" id="FileCache.flush_file-toggle" onclick="return toggle('FileCache.flush_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#flush_file">flush_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.flush_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.flush_file-expanded"><a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">      Removes a file from the cache</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the file to remove</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">      <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> </tt>
</div><a name="FileCache.add_store"></a><div id="FileCache.add_store-def"><a name="L206"></a><tt class="py-lineno">206</tt> <a class="py-toggle" href="#" id="FileCache.add_store-toggle" onclick="return toggle('FileCache.add_store');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#add_store">add_store</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">store</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.add_store-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.add_store-expanded"><a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring">      Adds a FileStore (server component) that can be queried to find files</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">      by name and transfer them into the cache</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">      @param store: FileStore instance to add</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">store</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stores</tt><tt class="py-op">:</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stores</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="simvoc.core.duplicate_filter.DuplicateFilter.append
simvoc.core.filter_results.ResultFilter.append
simvoc.core.kernel.Output.append" class="py-name" href="#" onclick="return doclink('link-15', 'append', 'link-10');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">store</tt><tt class="py-op">)</tt> </tt>
</div><a name="FileCache.remove_store"></a><div id="FileCache.remove_store-def"><a name="L215"></a><tt class="py-lineno">215</tt> <a class="py-toggle" href="#" id="FileCache.remove_store-toggle" onclick="return toggle('FileCache.remove_store');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#remove_store">remove_store</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">store</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.remove_store-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.remove_store-expanded"><a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"><tt class="py-docstring">      Removes a FileStore from the list of servers that can be queried</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-docstring">      @param store: FileStore instance to remove</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">stores</tt><tt class="py-op">.</tt><tt class="py-name">remove</tt><tt class="py-op">(</tt><tt class="py-name">store</tt><tt class="py-op">)</tt> </tt>
</div><a name="FileCache.__str__"></a><div id="FileCache.__str__-def"><a name="L222"></a><tt class="py-lineno">222</tt> <a class="py-toggle" href="#" id="FileCache.__str__-toggle" onclick="return toggle('FileCache.__str__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileCache-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileCache.__str__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileCache.__str__-expanded"><a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line">      <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-string">'FileCache: %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line">      <tt class="py-keyword">for</tt> <tt class="py-name">df</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cache</tt><tt class="py-op">:</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line">         <tt class="py-name">result</tt> <tt class="py-op">+=</tt> <tt class="py-string">'   '</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">df</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div></div><a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"> </tt>
<a name="FileStore"></a><div id="FileStore-def"><a name="L230"></a><tt class="py-lineno">230</tt> <a class="py-toggle" href="#" id="FileStore-toggle" onclick="return toggle('FileStore');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html">FileStore</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="FileStore-expanded"><a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">   Simulated file server, which stores DataFile instances using a filename</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">   map. Filenames must be unique within each FileStore.</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="FileStore.__init__"></a><div id="FileStore.__init__-def"><a name="L235"></a><tt class="py-lineno">235</tt> <a class="py-toggle" href="#" id="FileStore.__init__-toggle" onclick="return toggle('FileStore.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">speed</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.__init__-expanded"><a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">      @param name: Name of this file server</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line"><tt class="py-docstring">      @type name: str</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the simulator object</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-docstring">      @param speed: Network link speed in BYTES per second (see L{units})</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-docstring">      @type speed: number</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Extra data</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> <tt class="py-op">=</tt> <tt class="py-name">name</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">speed</tt> <tt class="py-op">=</tt> <tt class="py-name">speed</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt> <tt class="py-op">=</tt> <tt class="py-name">sim</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">extra_data</tt> <tt class="py-op">=</tt> <tt class="py-name">kwds</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
</div><a name="FileStore.has_file"></a><div id="FileStore.has_file-def"><a name="L249"></a><tt class="py-lineno">249</tt> <a class="py-toggle" href="#" id="FileStore.has_file-toggle" onclick="return toggle('FileStore.has_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#has_file">has_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.has_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.has_file-expanded"><a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the file to check</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff the requested filename is available from this server</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt> </tt>
</div><a name="FileStore.get_file"></a><div id="FileStore.get_file-def"><a name="L258"></a><tt class="py-lineno">258</tt> <a class="py-toggle" href="#" id="FileStore.get_file-toggle" onclick="return toggle('FileStore.get_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#get_file">get_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">,</tt> <tt class="py-param">cache_name</tt><tt class="py-op">,</tt> <tt class="py-param">local_speed</tt><tt class="py-op">,</tt> <tt class="py-param">callback</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.get_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.get_file-expanded"><a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">      Requests a file transfer from the server to a client. This transfer is</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-docstring">      performed using the transfer() method of the DataFile object itself,</tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring">      using the minimum of the server network link speed and client network</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">      link speed. Transfers are asynchronous: a call to this method will</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">      schedule a simulator event at the same time, or in the future, that</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">      will execute the callback function with the transfer result. If the</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">      file cannot be found in the data store, an Exception will occur.</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the file to transfer</tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line"><tt class="py-docstring">      @param cache_name: Name of the client making the request</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"><tt class="py-docstring">      @type cache_name: str</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"><tt class="py-docstring">      @param local_speed: Local network link speed of the client in BYTES</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-docstring">                          per second (see L{units})</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-docstring">      @type local_speed: number</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-docstring">      @param callback: Transfer callback function. See the documentation</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-docstring">                       for L{DataFile.transfer} for details.</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">filename</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt><tt class="py-op">:</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Simulated file not found in store: %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line">      <tt class="py-name">now</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="simvoc.core.kernel.Simulator.get_time" class="py-name" href="#" onclick="return doclink('link-16', 'get_time', 'link-7');">get_time</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line">      <tt class="py-name">datafile</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line">      <tt class="py-name">datafile</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method simvoc.core.storage.DataFile.transfer()=simvoc.core.storage.DataFile-class.html#transfer"><a title="simvoc.core.storage.DataFile.transfer" class="py-name" href="#" onclick="return doclink('link-17', 'transfer', 'link-17');">transfer</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">,</tt> <tt class="py-name">now</tt><tt class="py-op">,</tt> <tt class="py-name">min</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">speed</tt><tt class="py-op">,</tt> <tt class="py-name">local_speed</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> \ </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">         <tt class="py-name">callback</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt><tt class="py-op">,</tt> <tt class="py-name">cache_name</tt><tt class="py-op">)</tt> </tt>
</div><a name="FileStore.add_file"></a><div id="FileStore.add_file-def"><a name="L284"></a><tt class="py-lineno">284</tt> <a class="py-toggle" href="#" id="FileStore.add_file-toggle" onclick="return toggle('FileStore.add_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#add_file">add_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">datafile</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.add_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.add_file-expanded"><a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line"><tt class="py-docstring">      Adds a file to the store</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"><tt class="py-docstring">      @param datafile: DataFile instance to add to the server store</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">      <tt class="py-name">filename</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">datafile</tt> </tt>
</div><a name="FileStore.remove_file"></a><div id="FileStore.remove_file-def"><a name="L292"></a><tt class="py-lineno">292</tt> <a class="py-toggle" href="#" id="FileStore.remove_file-toggle" onclick="return toggle('FileStore.remove_file');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#remove_file">remove_file</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">filename</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.remove_file-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.remove_file-expanded"><a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line"><tt class="py-docstring">      Removes a file from the server store</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">      @param filename: Name of the file to remove</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">      @type filename: str</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line">      <tt class="py-keyword">del</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt><tt class="py-op">[</tt><tt class="py-name">filename</tt><tt class="py-op">]</tt> </tt>
</div><a name="FileStore.__str__"></a><div id="FileStore.__str__-def"><a name="L300"></a><tt class="py-lineno">300</tt> <a class="py-toggle" href="#" id="FileStore.__str__-toggle" onclick="return toggle('FileStore.__str__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.storage.FileStore-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="FileStore.__str__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="FileStore.__str__-expanded"><a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line">      <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-string">'FileStore: %s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">name</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line">      <tt class="py-keyword">for</tt> <tt class="py-name">name</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">filemap</tt><tt class="py-op">:</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line">         <tt class="py-name">result</tt> <tt class="py-op">+=</tt> <tt class="py-string">'   '</tt> <tt class="py-op">+</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">name</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">'\n'</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div></div><a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:35 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
